/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
using System;

namespace org.apache.commons.compress.archivers.zip {

    /**
     * Info-ZIP Unicode Path Extra Field (0x7075):
     *
     * <p>Stores the UTF-8 version of the file name field as stored in the 
     * local header and central directory header.</p>
     *
     * <pre>
     *         Value         Size        Description
     *         -----         ----        -----------
     * (UPath) 0x7075        Short       tag for this extra block type ("up")
     *         TSize         Short       total data size for this block
     *         Version       1 byte      version of this extra field, currently 1
     *         NameCRC32     4 bytes     File Name Field CRC32 Checksum
     *         UnicodeName   Variable    UTF-8 version of the entry File Name
     * </pre>
     * @NotThreadSafe super-class is not thread-safe
     */
    public class UnicodePathExtraField : AbstractUnicodeExtraField {

        public static readonly ZipShort UPATH_ID = new ZipShort(0x7075);

        public UnicodePathExtraField () { 
        }

        /**
         * Assemble as unicode path extension from the name given as
         * text as well as the encoded bytes actually written to the archive.
         * 
         * @param text The file name
         * @param bytes the bytes actually written to the archive
         * @param off The offset of the encoded filename in <code>bytes</code>.
         * @param len The length of the encoded filename or comment in
         * <code>bytes</code>.
         */
        public UnicodePathExtraField(String text, byte[] bytes, int off, int len) :base (text,bytes,off,len) {
        }

        /**
         * Assemble as unicode path extension from the name given as
         * text as well as the encoded bytes actually written to the archive.
         * 
         * @param name The file name
         * @param bytes the bytes actually written to the archive
         */
        public UnicodePathExtraField(String name, byte[] bytes)  : base (name,bytes){
        }

        /** {@inheritDoc} */
        public override ZipShort getHeaderId() {
            return UPATH_ID;
        }
    }
}